home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / dmedia / midisynth.z / midisynth
Encoding:
Text File  |  2002-10-03  |  15.7 KB  |  331 lines
  1.  
  2.  
  3.  
  4. mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))                                                      mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      midisynth - software MIDI synthesizer
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      mmmmiiiiddddiiiissssyyyynnnntttthhhh [[[[OOOOppppttttiiiioooonnnnssss]]]] [[[[PPPPrrrreeeesssseeeettttFFFFiiiilllleeee1111]]]] [[[[PPPPrrrreeeesssseeeettttFFFFiiiilllleeee2222]]]] [[[[............]]]][[[[PPPPrrrreeeesssseeeettttFFFFiiiilllleeee11116666]]]]
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      mmmmiiiiddddiiiissssyyyynnnntttthhhh is a program which listens on the MIDI input port and generates
  16.      sounds in real time in response to MIDI events.
  17.  
  18.      mmmmiiiiddddiiiissssyyyynnnntttthhhh has the following command-line options, most with a short and
  19.      long form as indicated:
  20.  
  21.      ----hhhh hhhheeeellllpppp
  22.           Print list of options.
  23.  
  24.      ----aaaa aaaallllllllMMMMIIIIDDDDIIII
  25.           Listen to all MIDI inputs.  Default is to listen to only the
  26.           'Software Synth' port.
  27.  
  28.      ----bbbbaaaannnnkkkk <<<<bbbbaaaannnnkkkkppppaaaatttthhhh>>>>
  29.           Use <bankpath> as the default GM preset bank.  Default is
  30.           /_u_s_r/_s_h_a_r_e/_d_a_t_a/_s_o_u_n_d_s/_s_y_n_t_h/_p_r_e_s_e_t_s/_G_e_n_e_r_a_l_M_I_D_I__S_o_u_n_d_S_e_t_L_e_v_e_l_1
  31.  
  32.      ----cccchhhhaaaannnnssss NNNN
  33.           Open an N-channel output port [2,4,8].  Default is 2.
  34.  
  35.      ----ccccppppuuuu <<<<lllliiiimmmmiiiitttt>>>>
  36.           Upper CPU usage limit.  Default is 75%.
  37.  
  38.      ----gggg ggggaaaaiiiinnnn
  39.           Main Gain (in Decibels).  Default is 0.
  40.  
  41.      ----ggggmmmm  Start up in General MIDI (GM) mode.  This is the default.
  42.  
  43.      ----ggggssss  Start up in General MIDI GS-compatible mode.
  44.  
  45.      ----nnnnggggmmmm Start up in non-General MIDI mode.
  46.  
  47.      ----ddddeeeevvvviiiicccceeee <<<<aaaauuuuddddiiiiooooddddeeeevvvv>>>>
  48.           Use audio output device <audiodev>.  Default is the currently-set
  49.           default output device.
  50.  
  51.      ----rrrr rrrraaaatttteeee
  52.           Sampling rate [8000..UP].  Default is 44100.
  53.  
  54.      ----tttt ttttiiiimmmmeeeeoooouuuutttt
  55.           Time out after last MIDI write port closed.  -1 = never, 0 =
  56.           immediate, 1..N = minutes.  Default is 5 minutes.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))                                                      mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))
  71.  
  72.  
  73.  
  74.      ----ttttuuuu ttttuuuunnnneeee
  75.           Tuning offset (Cents).  Default is 0 cents.
  76.  
  77.      ----vvvv vvvveeeerrrrbbbboooosssseeee
  78.           Print MIDI events to screen or console.  Default is false.
  79.  
  80.      ----vvvvoooo vvvvooooiiiicccceeeeccccoooouuuunnnntttt
  81.           Startup voice capacity of synthesizer [2..255].  Default varies with
  82.           CPU architecture.
  83.  
  84.      ----oooo ooooppppeeeennnnffffiiiilllleeee
  85.           Read startup state file.  Default is $(_H_O_M_E)/._m_i_d_i_s_y_n_t_h_r_c.
  86.  
  87.      PPPPrrrreeeesssseeeettttFFFFiiiilllleeee1111 ............ PPPPrrrreeeesssseeeettttFFFFiiiilllleeee11116666
  88.           Midisynth may be given a list of up to 16 preset file names.  These
  89.           will be assigned to channels 1 through 16, in order, but will ignore
  90.           the entry for channel 10 (the Percussion channel) if mmmmiiiiddddiiiissssyyyynnnntttthhhh is
  91.           started in General MIDI mode.  The file names must be specified as
  92.           full paths to the files.
  93.  
  94. TTTTHHHHEEEE DDDDEEEEFFFFAAAAUUUULLLLTTTT SSSSOOOOUUUUNNNNDDDD SSSSEEEETTTT
  95.      Midisynth's default basic sound set is the GGGGeeeennnneeeerrrraaaallll MMMMIIIIDDDDIIII 128 Preset
  96.      library, whose preset files are located in
  97.      /_u_s_r/_s_h_a_r_e/_d_a_t_a/_s_o_u_n_d_s/_s_y_n_t_h/_p_r_e_s_e_t_s.  Alternate GM preset directories or
  98.      preset bank files may be specified on the command line as indicated.
  99.      Customized sounds may be created using real-time MIDI System Exclusive
  100.      messages and editing synth preset files.
  101.  
  102.      mmmmiiiiddddiiiissssyyyynnnntttthhhh is autostarted the first time an application opens a MIDI write
  103.      port on the SoftwareSynth MIDI device.  mmmmiiiiddddiiiissssyyyynnnntttthhhh times out (shuts itself
  104.      off) five minutes after the last MIDI write port on the SoftwareSynth
  105.      MIDI device is closed.
  106.  
  107. HHHHAAAANNNNDDDDLLLLIIIINNNNGGGG OOOOFFFF TTTTHHHHEEEE MMMMIIIIDDDDIIII DDDDAAAATTTTAAAA IIIINNNNPPPPUUUUTTTT
  108.      mmmmiiiiddddiiiissssyyyynnnntttthhhh starts up with a MIDI input port on the SoftwareSynth MIDI
  109.      device.  Additional MIDI Devices may be added with Port Setup from the
  110.      ToolChest System Manager.  Use ssssyyyynnnntttthhhhppppaaaannnneeeellll(1) to toggle mmmmiiiiddddiiiissssyyyynnnntttthhhh's
  111.      response to data from the available MIDI devices.  mmmmiiiiddddiiiissssyyyynnnntttthhhh merges all
  112.      inputs into a single 16-channel stream and processes all messages.
  113.      Currently, mmmmiiiiddddiiiissssyyyynnnntttthhhh merges the preset and controllers from all input
  114.      devices, but Note On/Off status is handled per device.  For example,
  115.      NOTEOFF to device "SoftwareSynth" will not cancel a NOTEON from device
  116.      "Serial Port 1".
  117.  
  118. CCCCPPPPUUUU UUUUSSSSAAAAGGGGEEEE LLLLIIIIMMMMIIIITTTTIIIINNNNGGGG
  119.      mmmmiiiiddddiiiissssyyyynnnntttthhhh runs with non-degrading priority, i.e., it will not relinquish
  120.      the CPU to any other process (with the exception of a few system
  121.      processes).  In order to avoid consuming the operating system's entire
  122.      resources, mmmmiiiiddddiiiissssyyyynnnntttthhhh uses a CPU usage limiting system.  When its
  123.      percentage of the CPU rises above a predetermined threshold (see ccccppppuuuuLLLLiiiimmmmiiiitttt
  124.      below), it attempts to reduce its usage until the percentage is below
  125.      that threshold.  It does this by killing off some of the active voices
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))                                                      mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))
  137.  
  138.  
  139.  
  140.      (using an internal heuristic designed to make this procedure as
  141.      unobtrusive as possible) until the CPU usage falls below the threshold.
  142.  
  143. RRRREEEELLLLAAAATTTTEEEEDDDD AAAAPPPPPPPPLLLLIIIICCCCAAAATTTTIIIIOOOONNNNSSSS
  144.      ssssyyyynnnntttthhhhppppaaaannnneeeellll(1) displays the 16 channel preset address space of mmmmiiiiddddiiiissssyyyynnnntttthhhh.
  145.      It also allows adding and selecting alternate preset banks, adjusting of
  146.      the master synthesizer volume, and selecting of MIDI input ports.
  147.  
  148.      mmmmiiiiddddiiiikkkkeeeeyyyyssss(1) may be used to play the synthesizer and change its presets on
  149.      a single MIDI channel at a time.
  150.  
  151.      ssssoooouuuunnnnddddppppllllaaaayyyyeeeerrrr(1) allows playback of standard MIDI data files via the
  152.      synthesizer.
  153.  
  154.      ssssyyyynnnntttthhhheeeeddddiiiittttoooorrrr(1) allows real-time editing of active presets and all
  155.      synthesizer parameters, as well as editing and creating new
  156.      ssssyyyynnnntttthhhhpppprrrreeeesssseeeetttt(4) files.
  157.  
  158. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
  159.      mmmmiiiiddddiiiissssyyyynnnntttthhhh reads a configuration file at startup time which allows a small
  160.      set of startup parameters to be configured by the user.  These parameters
  161.      are the same as those available on the command line.  mmmmiiiiddddiiiissssyyyynnnntttthhhh looks for
  162.      files in the following three places, stopping after the first of these is
  163.      found:
  164.  
  165.      $_H_O_M_E/_m_i_d_i_s_y_n_t_h._s_t_a_r_t_u_p
  166.      $_H_O_M_E/._m_i_d_i_s_y_n_t_h_r_c
  167.      /_v_a_r/_d_m_e_d_i_a/_m_i_d_i/_m_i_d_i_s_y_n_t_h/_s_t_a_r_t_u_p
  168.  
  169.      Note that none these files is present by default, nor is the subdirectory
  170.      /_v_a_r/_d_m_e_d_i_a/_m_i_d_i/_m_i_d_i_s_y_n_t_h.  This could be added by the system
  171.      administrator.
  172.  
  173.      Each parameter must be on a line of its own, and must be in the form
  174.  
  175.      mmmmiiiiddddiiiissssyyyynnnntttthhhh****ppppaaaarrrraaaammmmeeeetttteeeerrrrNNNNaaaammmmeeee:::: ppppaaaarrrraaaammmmeeeetttteeeerrrrVVVVaaaalllluuuueeee
  176.  
  177.      The following parameters may be set:
  178.  
  179.      ccccppppuuuuLLLLiiiimmmmiiiitttt
  180.           Upper limit of CPU usage allowed before mmmmiiiiddddiiiissssyyyynnnntttthhhh will begin to kill
  181.           off voices.  Default is 75 (percent).
  182.  
  183.      ddddeeeeffffaaaauuuullllttttBBBBaaaannnnkkkk
  184.           The full path to an alternate General MIDI preset bank.  This may
  185.           either be a directory containing preset files, or a SoundFont2-
  186.           compatible preset bank file.
  187.  
  188.      oooouuuuttttppppuuuuttttDDDDeeeevvvviiiicccceeee
  189.           A string representing the audio output device to use.  Legal values
  190.           are the AAAALLLL____NNNNAAAAMMMMEEEE parameters for the various audio devices. The
  191.           default is "DefaultOut".
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))                                                      mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))
  203.  
  204.  
  205.  
  206.      ggggaaaaiiiinnnnIIIInnnnddddBBBB
  207.           Master gain in decibels for the MIDI voices.  Default is 0.
  208.  
  209.      ggggeeeennnneeeerrrraaaallllMMMMIIIIDDDDIIII
  210.           Boolean.  If True then midisynth will start up in general MIDI mode,
  211.           with channel 10 dedicated to the Percussion map.  Default is True.
  212.  
  213.      iiiinnnnppppuuuuttttFFFFrrrroooommmmAAAAllllllllMMMMIIIIDDDDIIIIDDDDeeeevvvviiiicccceeeessss
  214.           Boolean.  If True then midisynth will read from all configured MIDI
  215.           input devices.  Default is False
  216.  
  217.      oooouuuuttttCCCChhhhaaaannnnnnnneeeellllssss
  218.           Number of channels of output audio to generate.  Legal values are 2,
  219.           4, and 8.  Default is 2.
  220.  
  221.      ssssaaaammmmpppplllliiiinnnnggggRRRRaaaatttteeee
  222.           Sampling rate in Hz for the output audio.  Default is 44100.
  223.           Setting this to lower values can significantly reduce CPU usage, but
  224.           will also decrease the sound quality.  Minimum is 8000.
  225.  
  226.      ttttuuuunnnneeeeIIIInnnnCCCCeeeennnnttttssss
  227.           Master detune of samples in cents (1/100 of a semitone).  Default is
  228.           0.
  229.  
  230.      pppprrrroooocccceeeessssssssLLLLeeeennnnggggtttthhhh
  231.           Length in samples of each generated audio buffer.  Smaller buffers
  232.           give better response time but consume more CPU.  For optimum
  233.           performance, this value should be a power of 2.  Default is 256.
  234.           Minimum is 128, and the maximum is 512.  This value _m_u_s_t be less
  235.           than or equal to sssstttteeeerrrreeeeooooQQQQuuuueeeeuuuueeeeSSSSiiiizzzzeeee.
  236.  
  237.      sssstttteeeerrrreeeeooooQQQQuuuueeeeuuuueeeeSSSSiiiizzzzeeee
  238.           Length in samples of the audio output port queue (see
  239.           aaaallllSSSSeeeettttQQQQuuuueeeeuuuueeeeSSSSiiiizzzzeeee(3dm).  Default is 1024 (4 x pppprrrroooocccceeeessssssssLLLLeeeennnnggggtttthhhh).
  240.  
  241.      ttttiiiimmmmeeeeOOOOuuuuttttIIIInnnnMMMMiiiinnnnuuuutttteeeessss
  242.           Time in minutes before midisynth will exit from lack of MIDI input.
  243.           If set to -1, midisynth will never exit for this reason.  Default is
  244.           5.
  245.  
  246.      vvvveeeerrrrbbbboooosssseeee
  247.           Boolean.  If True, midisynth operates in verbose mode, and will
  248.           print information about events received to the terminal (or the
  249.           console) via stdout.  Default is False.
  250.  
  251.      vvvvooooiiiicccceeeeCCCCoooouuuunnnntttt
  252.           The maximum number of polyphonic voices that can sound at one time.
  253.           Note that this is an upper limit, but that the CPU limiting factor
  254.           will also set an upper limit which, depending on the CPU, may be
  255.           lower than this value.  For an R4000 processor, 24 is a reasonable
  256.           upper bound.  For an R5000, 32 is good.  For faster and/or
  257.           multiprocessor machines, higher values will work, often over 100
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))                                                      mmmmiiiiddddiiiissssyyyynnnntttthhhh((((1111))))
  269.  
  270.  
  271.  
  272.           voices.  Minimum is 2 and maximum is 255.
  273.  
  274.      Command-line arguments will override any default or configuration-file
  275.      settings.
  276.  
  277. HHHHAAAARRRRDDDDWWWWAAAARRRREEEE
  278.      _m_i_d_i_s_y_n_t_h runs on Iris Indigo R4000, Indigo2, Indy, O2, Octane, and
  279.      Onyx/Challenge machines fitted with the SGI Audio Serial Option (ASO)
  280.      Board.
  281.  
  282. BBBBUUUUGGGGSSSS
  283.      Please refer to the release notes for dmedia_eoe for futher information.
  284.  
  285. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  286.      synthpreset(4), midikeys(1), synthpanel(1), syntheditor(1),
  287.      soundplayer(1)
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.